Learner.AudioLevel Property

Gets or sets the audio level preference of the learner.

Parent Type: Learner

Namespace: Microsoft.LearningComponents.DataModel

Assembly: Microsoft.LearningComponents.dll

Syntax
C#

public float AudioLevel

{ get; set; }
Exceptions
Exception type Condition
InvalidOperationException

Thrown if this LearningDataModel object cannot be written to.

ArgumentOutOfRangeException

Thrown if the value passed is less than 0.0 for SCORM 2004 packages, or if it is not an integer or is less than -32768 or greater than 100 for SCORM 1.2 packages.

Remarks

In SCORM 2004, this corresponds to cmi.learner_preference.audio_level.

In SCORM 1.2, this corresponds to cmi.student_preference.audio.

In SCORM 2004, this property is a multiplier value that specifies an intended change in perceived audio volume level relative to an implementation-specific reference level where 1 indicates no change. For example, the value 0 specifies "off", the value of 0.5 represents half volume and a value of 2 indicates double volume.

In SCORM 1.2, any negative number represents audio being "off", 0 indicates no change of status, and a number from 1 to 100 indicates a volume level from softest to loudest.